Account Information Services APIs 4.0
Account and Transaction Information Examples
Account and Transaction Information Examples
This section provides examples of API invocation covering Account resource access to retrieve account information, balance and transaction information.
1. Multiple account information
This is the first API that an AISP invokes (after the account request is authorised) to get the unique identifier (AccountID) for each PSU consented account.
The following optional field(s) is/are not populated by BOI for this API:
• Description
• Account.SecondaryIdentification
• Account.Name
• OpeningDate
• MaturityDate
GET request: accounts
GET /accounts HTTP/1.1
Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 234.213.211.123
x-fapi-interaction-id: 9e82e6ec-6922-4881-9d26-25600bec3f5d
Accept: application/jsonGET response: accounts
HTTP/1.1 200 OK
x-fapi-interaction-id: 9e82e6ec-6922-4881-9d26-25600bec3f5d
Content-Type: application/json
{
"Data": {
"Account": [
{
"AccountId": "53c8d38e-ad32-4944-9bc3-96e971229fe4",
"Status": "Disabled",
"StatusUpdateDateTime": "2019-01-01T06:06:06+00:00",
"Currency": "GBP",
"AccountCategory": "Business",
"AccountTypeCode": "CARD",
"Description": "CMA4Description",
"Nickname": "Sayali",
"Account": [
{
"SchemeName": "UK.OBIE.IBAN",
"Identification": "GB33BUKB20201555555556",
"Name": "WILLIAMS",
"SecondaryIdentification": "54989"
}
],
"StatementFrequencyAndFormat": [
{}
],
"Servicer": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "901701",
"Name": "test1"
}
},
{
"AccountId": "1650ffb7-23dc-4c70-9ed3-144a8a562809",
"Status": "Pending",
"StatusUpdateDateTime": "2019-01-01T06:06:06+00:00",
"Currency": "GBP",
"AccountCategory": "Business",
"AccountTypeCode": "CASH",
"Description": "CMA4Description",
"Nickname": "Sayali",
"Account": [
{
"SchemeName": "UK.OBIE.IBAN",
"Identification": "GB33BUKB20201555555557",
"Name": "KEITH",
"SecondaryIdentification": "54100"
}
],
"StatementFrequencyAndFormat": [
{}
],
"Servicer": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "901702",
"Name": "test1"
}
},
{
"AccountId": "2cf31498-b139-41ef-b4cf-cb9989db5b42",
"Status": "ProForma",
"StatusUpdateDateTime": "2019-01-01T06:06:06+00:00",
"Currency": "GBP",
"AccountCategory": "Business",
"AccountTypeCode": "CHAR",
"Description": "CMA4Description",
"Nickname": "Sayali",
"Account": [
{
"SchemeName": "UK.OBIE.IBAN",
"Identification": "GB33BUKB20201555555558",
"Name": "PAUL",
"SecondaryIdentification": "54101"
}
],
"StatementFrequencyAndFormat": [
{}
],
"Servicer": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "901703",
"Name": "test1"
}
}
]
},
"Links": {
"Self": "https://api-sandbox.boicloudtest.net/1/api/open-banking/v4.0/aisp/accounts"
},
"Meta": {
"TotalPages": 1
}
}2. Single account information
This API allows an AISP to retrieve information of a single bank account identified by the unique AccountID.
The following optional field(s) is/are not populated by BOI for this API:
• Description
• Account.SecondaryIdentification
• Account.Name
• OpeningDate
• MaturityDate
GET request: accounts
GET /accounts/ ca016e3b-2409-4b83-9c29-f6cd221e828b HTTP/1.1
Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 234.213.211.123
x-fapi-interaction-id: f42c67b8-bf6d-4b22-8e0e-2cde79c19a93
Accept: application/json
GET response: accounts
HTTP/1.1 200 OK
x-fapi-interaction-id: f42c67b8-bf6d-4b22-8e0e-2cde79c19a93
Content-Type: application/json
{
"Data": {
"Account": [
{
"AccountId": "ca016e3b-2409-4b83-9c29-f6cd221e828b",
"Status": "Enabled",
"StatusUpdateDateTime": "2019-01-01T06:06:06+00:00",
"Currency": "GBP",
"AccountCategory": "Personal",
"AccountTypeCode": "COMM",
"Description": "CMA4Description",
"Nickname": "Sayali",
"Account": [
{
"SchemeName": "UK.OBIE.IBAN",
"Identification": "GB33BUKB20201555555560",
"Name": "LEE",
"SecondaryIdentification": "54103"
}
],
"StatementFrequencyAndFormat": [
{}
],
"Servicer": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "901705",
"Name": "test1"
}
}
]
},
"Links": {
"Self": "https://api-sandbox.boicloudtest.net/1/api/open-banking/v4.0/aisp/accounts/ca016e3b-2409-4b83-9c29-f6cd221e828b"
},
"Meta": {
"TotalPages": 1
}
}3. Account Balance
This API allows an AISP to retrieve balance information of a single bank account identified by the unique AccountID.
GET request : Accounts Balances
GET /accounts/ca016e3b-2409-4b83-9c29-f6cd221e828b/balances HTTP/1.1
Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 234.213.211.123
x-fapi-interaction-id: 1456203d-9db1-455b-8a41-dca4e70f740c
Accept: application/jsonGET response: Accounts Balances
HTTP/1.1 200 OK
x-fapi-interaction-id: 1456203d-9db1-455b-8a41-dca4e70f740c
Content-Type: application/json
{
"Data": {
"Balance": [
{
"AccountId": "ca016e3b-2409-4b83-9c29-f6cd221e828b",
"CreditDebitIndicator": "Debit",
"Type": "ITBD",
"DateTime": "2018-09-09T10:43:07+00:00",
"Amount": {
"Amount": "1230.00",
"Currency": "GBP",
"SubType": "BCUR"
},
"CreditLine": [
{
"Included": true,
"Type": "Temporary",
"Amount": {
"Amount": "1000.00",
"Currency": "GBP"
}
}
],
"LocalAmount": {
"Amount": "1010.00",
"Currency": "GBP",
"SubType": "LCUR"
}
}
],
"TotalValue": {
"Amount": "1000.00",
"Currency": "GBP"
}
},
"Links": {
"Self": "https://api-sandbox.boicloudtest.net/1/api/open-banking/v4.0/aisp/accounts/ca016e3b-2409-4b83-9c29-f6cd221e828b/balances"
},
"Meta": {
"TotalPages": 1
}
}4. Beneficiaries
This API allows an AISP to retrieve the list of trusted beneficiaries linked to a specific customer.
The following optional field(s) is/are not populated by BOI for this API:
• CreditorAgent.Name
• CreditorAgent.PostalAddress
• CreditorAccount.SecondaryIdentification
• SupplementaryData
GET request: Accounts Beneficiaries
GET /accounts/ca016e3b-2409-4b83-9c29-f6cd221e828b/beneficiaries HTTP/1.1
Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 234.213.211.123
x-fapi-interaction-id: c95cb7c8-7da6-41fd-b10a-870f3b07e6e1
Accept: application/jsonGET response: Accounts Beneficiaries
HTTP/1.1 200 OK
x-fapi-interaction-id: c95cb7c8-7da6-41fd-b10a-870f3b07e6e1
Content-Type: application/json
{
"Data": {
"Beneficiary": [
{
"AccountId": "ca016e3b-2409-4b83-9c29-f6cd221e828b",
"BeneficiaryId": "string",
"BeneficiaryType": "Trusted",
"Reference": "string",
"CreditorAgent": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "string",
"Name": "string",
"PostalAddress": {
"AddressType": "HOME",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"PostCode": "EC2N 4AG",
"TownName": "London",
"CountrySubDivision": "London City",
"Country": "GB",
"AddressLine": [
"line 1"
]
}
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE31BOFIXXXXXXXX345678",
"Name": "string",
"SecondaryIdentification": "123"
}
}
]
},
"Links": {
"Self": "https://api-sandbox.boicloudtest.net/1/api/open-banking/v4.0/aisp/accounts/ca016e3b-2409-4b83-9c29-f6cd221e828b/beneficiaries"
},
"Meta": {
"TotalPages": 1
}
}5. Product – Specific Account
This API allows an AISP to retrieve the product details specific to an account.
The following optional field(s) is/are not populated by BOI for this API:
• SecondaryProductId
• ProductName
• MarketingStateId
• OtherProductType
• BCA
• PCA
GET request: Accounts Product
GET /accounts/ca016e3b-2409-4b83-9c29-f6cd221e828b/product HTTP/1.1
Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 234.213.211.123
x-fapi-interaction-id: 4b955ddb-1f80-4769-b826-c43599852876
Accept: application/jsonGET response: Accounts Product
HTTP/1.1 200 OK
x-fapi-interaction-id: 4b955ddb-1f80-4769-b826-c43599852876
Content-Type: application/json
{
"Data": {
"Product": [
{
"ProductName": "test",
"ProductId": "test",
"AccountId": "ca016e3b-2409-4b83-9c29-f6cd221e828b",
"SecondaryProductId": "test",
"ProductType": "BusinessCurrentAccount",
"MarketingStateId": "testRAMA",
"BCA": {
"ProductDetails": {
"Segment": [
"ClientAccount",
"Standard",
"NonCommercialChaitiesClbSoc",
"NonCommercialPublicAuthGovt",
"Religious",
"SectorSpecific",
"Startup",
"Switcher"
],
"FeeFreeLength": 10.0,
"FeeFreeLengthPeriod": "Month",
"Notes": [
"111111111"
]
},
"CreditInterest": {
"TierBandSet": [
{
"TierBandMethod": "Whole",
"CalculationMethod": "SimpleInterest",
"Destination": "SelfCredit",
"Notes": [
"111111111"
],
"TierBand": [
{
"aer": "334.3305",
"Identification": "test",
"TierValueMinimum": "-10000000000000.001",
"TierValueMaximum": "-10000000000000.0",
"CalculationFrequency": "Monthly",
"ApplicationFrequency": "Monthly",
"DepositInterestAppliedCoverage": "Whole",
"FixedVariableInterestRateType": "Variable",
"AER": "334.3305",
"BankInterestRateType": "Other",
"BankInterestRate": "11.3305",
"Notes": [
"11111"
],
"OtherBankInterestType": {
"Code": "123e",
"Name": "abh",
"Description": "afhkfh"
},
"OtherApplicationFrequency": {
"Code": "123e",
"Name": "111111",
"Description": "abhsh"
},
"OtherCalculationFrequency": {
"Code": "123e",
"Name": "1111111111",
"Description": "111111111111"
}
}
]
}
]
},
"Overdraft": {
"Notes": [
"string"
],
"OverdraftTierBandSet": [
{
"TierBandMethod": "Whole",
"OverdraftType": "OnDemand",
"Identification": "test",
"AuthorisedIndicator": false,
"BufferAmount": "123456789101.99",
"Notes": [
"string"
],
"OverdraftTierBand": [
{
"ear": "333.3333",
"Identification": "testtt",
"TierValueMin": "11111112222221.9999",
"TierValueMax": "11111112222221.9999",
"EAR": "333.3333",
"AgreementLengthMin": 2.0,
"AgreementLengthMax": 99.0,
"AgreementPeriod": "Month",
"OverdraftInterestChargingCoverage": "Whole",
"BankGuaranteedIndicator": false,
"Notes": [
"KIRANTEST"
],
"OverdraftFeesCharges": [
{
"OverdraftFeeChargeCap": [
{
"FeeType": [
"EmergencyBorrowing"
],
"MinMaxType": "Maximum",
"FeeCapOccurrence": 11111111,
"FeeCapAmount": "9999999999.9999",
"CappingPeriod": "Month",
"Notes": [
"string"
],
"OtherFeeType": [
{
"Code": "5555",
"Name": "testt",
"Description": "abhkjkf"
}
]
}
],
"OverdraftFeeChargeDetail": [
{
"FeeType": "EmergencyBorrowing",
"NegotiableIndicator": false,
"OverdraftControlIndicator": false,
"IncrementalBorrowingAmount": "99999999999999.9999",
"FeeAmount": "99999999999999.9999",
"FeeRate": "333.11",
"FeeRateType": "Other",
"ApplicationFrequency": "ChargingPeriod",
"CalculationFrequency": "ChargingPeriod",
"Notes": [
"string"
],
"OverdraftFeeChargeCap": [
{
"FeeType": [
"EmergencyBorrowing"
],
"MinMaxType": "Maximum",
"FeeCapOccurrence": 100.0,
"FeeCapAmount": "99999999999999.9977",
"CappingPeriod": "Month",
"Notes": [
"TESTnOTESTESTNOTEST"
],
"OtherFeeType": [
{
"Code": "",
"Name": "ASGH",
"Description": "ASK"
}
]
}
],
"OtherFeeType": {
"Code": "TEST",
"Name": "ASH",
"Description": "AKKKK"
},
"OtherFeeRateType": {
"Code": "stUU",
"Name": "ASGH",
"Description": "string"
},
"OtherApplicationFrequency": {
"Code": "str4",
"Name": "string",
"Description": "ASDKKKK"
},
"OtherCalculationFrequency": {
"Code": "str4",
"Name": "string",
"Description": "ASDKKKKK"
}
}
]
}
]
}
],
"OverdraftFeesCharges": [
{
"OverdraftFeeChargeCap": [
{
"FeeType": [
"EmergencyBorrowing"
],
"MinMaxType": "Maximum",
"FeeCapOccurrence": 1.0,
"FeeCapAmount": "99999.99",
"CappingPeriod": "Month",
"Notes": [
"string"
],
"OtherFeeType": [
{
"Code": "str4",
"Name": "ASkGH",
"Description": "string"
}
]
}
],
"OverdraftFeeChargeDetail": [
{
"FeeType": "EmergencyBorrowing",
"NegotiableIndicator": false,
"OverdraftControlIndicator": false,
"IncrementalBorrowingAmount": "99999999999999.9999",
"FeeAmount": "99999999999999.99",
"FeeRate": "333.1122",
"FeeRateType": "Other",
"ApplicationFrequency": "ChargingPeriod",
"CalculationFrequency": "ChargingPeriod",
"Notes": [
"string"
],
"OverdraftFeeChargeCap": [
{
"FeeType": [
"EmergencyBorrowing"
],
"MinMaxType": "Maximum",
"FeeCapOccurrence": 1.0,
"FeeCapAmount": "99999999999999.9999",
"CappingPeriod": "Month",
"Notes": [
"string"
],
"OtherFeeType": [
{
"Code": "st41",
"Name": "testttttttttt",
"Description": "abhkjhakhakfhkfhajKKt"
}
]
}
],
"OtherFeeType": {
"Code": "str4",
"Name": "string",
"Description": "testttttttt"
},
"OtherFeeRateType": {
"Code": "str4",
"Name": "testtttttt",
"Description": "string"
},
"OtherApplicationFrequency": {
"Code": "str4",
"Name": "string",
"Description": "string"
},
"OtherCalculationFrequency": {
"Code": "str4",
"Name": "string",
"Description": "string"
}
}
]
}
]
}
]
},
"OtherFeesCharges": [
{
"TariffType": "Other",
"TariffName": "akfhkfhajkfh",
"OtherTariffType": {
"Code": "qwe2",
"Name": "111111111qw",
"Description": "1111111111111"
},
"FeeChargeDetail": [
{
"FeeCategory": "Servicing",
"FeeType": "ServiceCAccountFeeQuarterly",
"NegotiableIndicator": false,
"FeeAmount": "-10000000000000.0001",
"FeeRate": "334.3305",
"FeeRateType": "Other",
"ApplicationFrequency": "ChargingPeriod",
"CalculationFrequency": "ChargingPeriod",
"Notes": [
"string"
],
"FeeChargeCap": [
{
"FeeType": [
"ServiceCAccountFee",
"ServiceCAccountFee",
"ServiceCAccountFeeMonthly",
"ServiceCAccountFeeQuarterly",
"ServiceCFixedTariff",
"ServiceCBusiDepAccBreakage",
"Other",
"ServiceCMinimumMonthlyFee",
"ServiceCOther"
],
"MinMaxType": "Minimum",
"FeeCapOccurrence": 50.0,
"FeeCapAmount": "-10000000000000.0001",
"CappingPeriod": "Month",
"Notes": [
"string"
],
"OtherFeeType": [
{
"Code": "str4",
"Name": "test",
"Description": "abhjfhadkfhakhakfhkfhajk"
}
]
}
],
"OtherFeeCategoryType": {
"Code": "str4",
"Name": "string",
"Description": "string"
},
"OtherFeeType": {
"Code": "str4",
"FeeCategory": "Other",
"Name": "string",
"Description": "string"
},
"OtherFeeRateType": {
"Code": "str4",
"Name": "string",
"Description": "string"
},
"OtherApplicationFrequency": {
"Code": "str4",
"Name": "string",
"Description": "string"
},
"OtherCalculationFrequency": {
"Code": "str4",
"Name": "string",
"Description": "string"
},
"FeeApplicableRange": {
"MinimumAmount": "-10000000000000.0001",
"MaximumAmount": "-10000000000000.0001",
"MinimumRate": "334.3305",
"MaximumRate": "334.3305"
}
}
],
"FeeChargeCap": [
{
"FeeType": [
"Other",
"ServiceCAccountFee",
"ServiceCAccountFeeMonthly",
"ServiceCAccountFeeQuarterly",
"ServiceCFixedTariff",
"ServiceCBusiDepAccBreakage",
"ServiceCMinimumMonthlyFee",
"ServiceCOther"
],
"MinMaxType": "Minimum",
"FeeCapOccurrence": 0.0,
"FeeCapAmount": "-10000000000000.0001",
"CappingPeriod": "Month",
"Notes": [
"string"
],
"OtherFeeType": [
{
"Code": "str4",
"Name": "testt",
"Description": "abhkakhakfhk"
}
]
}
]
}
]
}
}
]
},
"Links": {
"Self": "https://api-sandbox.boicloudtest.net/1/api/open-banking/v4.0/aisp/accounts/ca016e3b-2409-4b83-9c29-f6cd221e828b/product"
},
"Meta": {
"TotalPages": 1
}
}6. Scheduled Payments – Specific Account
This API allows an AISP to retrieve the list of scheduled payments for a specific account.
The following optional field(s) is/are not populated by BOI for this API:
• DebtorReference
GET request: Accounts Scheduled Payments
GET /accounts/ca016e3b-2409-4b83-9c29-f6cd221e828b/scheduled-payments HTTP/1.1
Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Accept: application/json
GET response: Accounts Scheduled Payments
HTTP/1.1 200 OK
x-fapi-interaction-id: 4102dbfa-6f6e-4244-b23e-85ff15012a43
Content-Type: application/json
{
"Data": {
"ScheduledPayment": [
{
"AccountId": "ca016e3b-2409-4b83-9c29-f6cd221e828b",
"ScheduledPaymentId": "SP03",
"ScheduledPaymentDateTime": "2026-08-05T10:21:33+00:00",
"ScheduledType": "Execution",
"Reference": "ABCGD55",
"DebtorReference": "12345",
"InstructedAmount": {
"Amount": "240.00",
"Currency": "GBP"
},
"CreditorAgent": {
"lei": "IZ9Q00LZEVUKWCQY6X15",
"SchemeName": "UK.OBIE.BICFI",
"Identification": "string",
"Name": "string",
"PostalAddress": {
"AddressType": "HOME",
"Department": "Finance",
"SubDepartment": "Payroll",
"StreetName": "Bank Street",
"BuildingNumber": "11",
"BuildingName": "Building A",
"Floor": "7",
"UnitNumber": "A88",
"Room": "Basement 03",
"PostBox": "PO123",
"TownLocationName": "Central London",
"DistrictName": "Greater London",
"CareOf": "John Doe",
"PostCode": "EC2N 4AG",
"TownName": "London",
"CountrySubDivision": "London City",
"Country": "GB",
"AddressLine": [
"line 1"
]
},
"LEI": "IZ9Q00LZEVUKWCQY6X15"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "23605490179017",
"Name": "JESSICA",
"SecondaryIdentification": "54988",
"Proxy": {
"Identification": "2360549017905188",
"Code": "COID",
"Type": "test"
}
}
}
]
},
"Links": {
"Self": "https://api-sandbox.boicloudtest.net/1/api/open-banking/v4.0/aisp/accounts/ca016e3b-2409-4b83-9c29-f6cd221e828b/scheduled-payments"
},
"Meta": {
"TotalPages": 1
}
}7. Standing Orders – Specific Account
This API allows an AISP to retrieve the list of standing orders that have been set up on a specific account.
The following optional field(s) is/are not populated by BOI for this API:
• FirstPaymentDateTime
• FirstPaymentAmount
• FinalPaymentDateTime
• FinalPaymentAmount
• StandingOrderStatusCode
• CreditorAgent
• CreditorAccount.SecondaryIdentification
• NumberofPayments
• LastPaymentAmount
• SupplementaryData
GET request: Accounts Standing Orders
GET /accounts/ca016e3b-2409-4b83-9c29-f6cd221e828b/standing-orders HTTP/1.1
Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 62940de7-8fd1-40d6-8ef0-83245fa95a9c
Accept: application/jsonGET response: Accounts Standing Orders
HTTP/1.1 200 OK
x-fapi-interaction-id: 62940de7-8fd1-40d6-8ef0-83245fa95a9c
Content-Type: application/json
{
"Data": {
"StandingOrder": [
{
"AccountId": "ca016e3b-2409-4b83-9c29-f6cd221e828b",
"StandingOrderId": "131213",
"NextPaymentDateTime": "2017-04-05T10:43:07+00:00",
"LastPaymentDateTime": "2017-04-05T10:43:07+00:00",
"NumberOfPayments": "5",
"StandingOrderStatusCode": "SUSP",
"FirstPaymentAmount": {
"Amount": "123488.765",
"Currency": "GBP"
},
"NextPaymentAmount": {
"Amount": "123488.765",
"Currency": "GBP"
},
"LastPaymentAmount": {
"Amount": "123488.765",
"Currency": "GBP"
},
"FinalPaymentAmount": {
"Amount": "123488.765",
"Currency": "GBP"
},
"CreditorAgent": {
"SchemeName": "UK.OBIE.BICFI",
"Identification": "String"
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.PAN",
"Identification": "string",
"Name": "JESSICA",
"SecondaryIdentification": "string"
}
}
]
},
"Links": {
"Self": "https://api-sandbox.boicloudtest.net/1/api/open-banking/v4.0/aisp/accounts/ca016e3b-2409-4b83-9c29-f6cd221e828b/standing-orders"
},
"Meta": {
"TotalPages": 1
}
}8. Account Statement – List of statements for a specific account
This API allows an AISP to retrieve statement information of a single bank account identified by the unique AccountID.
The following optional field(s) is/are not populated by BOI for this API:
• StatementDescription
• StatementReference
• StatementBenefit
• StatementFee
• StatementInterest
• StatementAmount
• StatementDateTime
• StatementRate
• StatementValue
GET request: Accounts Statements
GET /accounts/27f4beab-01df-4d05-8782-05d7e7e31237/statements HTTP/1.1
Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 234.213.211.123
x-fapi-interaction-id: 648c0903-6828-48ee-99fe-c5fbcf4cb929
Content-Type: application/json
Accept: application/jsonGET response: Accounts Statements
HTTP/1.1 200 OK
x-fapi-interaction-id: 648c0903-6828-48ee-99fe-c5fbcf4cb929
Content-Type: application/json
{
"Data": {
"Statement": [
{
"AccountId": "27f4beab-01df-4d05-8782-05d7e7e31237",
"StatementId": "333335",
"StatementReference": "001",
"Type": "Interim",
"StartDateTime": "2026-06-15T00:00:00+00:00",
"EndDateTime": "2026-06-30T23:59:59+00:00",
"CreationDateTime": "2026-06-15T00:00:00.000+00:00",
"StatementDescription": [
"August 2017 Statement One Free Uber Ride"
],
"StatementBenefit": [
{
"Type": "CASHBACK",
"Amount": {
"Amount": "1234567891234.12345",
"Currency": "GBP"
}
}
],
"StatementFee": [
{
"Description": "This is the statement fee",
"CreditDebitIndicator": "Debit",
"Type": "GAMBLING",
"Rate": "1.5",
"RateType": "UK.OBIE.EAR",
"Frequency": "UK.OBIE.PerTransactionPercentage",
"Amount": {
"Amount": "1234567891233.12345",
"Currency": "USD"
}
}
],
"StatementInterest": [
{
"Description": "This is the statement fee",
"CreditDebitIndicator": "Debit",
"Type": "ESTIMATEDNEXT",
"RateType": "UK.OBIE.EAR",
"Frequency": "UK.OBIE.PerTransactionPercentage",
"Amount": {
"Amount": "1234567891999.1234",
"Currency": "GBP"
}
}
],
"StatementAmount": [
{
"CreditDebitIndicator": "Debit",
"Type": "ESTIMATEDNEXT",
"Amount": {
"Amount": "1234567891999.12345",
"Currency": "GBP",
"SubType": "BCUR"
},
"LocalAmount": {
"Amount": "1234567891999.12345",
"Currency": "GBP",
"SubType": "LCUR"
}
}
],
"StatementDateTime": [
{
"DateTime": "2018-07-23T10:29:22.765Z",
"Type": "PURCHASEPROMOEND"
}
],
"StatementRate": [
{
"Rate": "1.5",
"Type": "ANNUALCASH"
}
],
"StatementValue": [
{
"Value": "1",
"Type": "RETAILSHOPPINGPOINTSBALANCE"
}
],
"TotalValue": {
"Amount": "1234567891999.12345",
"Currency": "GBP"
}
}
]
},
"Links": {
"Self": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/aisp/accounts/27f4beab-01df-4d05-8782-05d7e7e31237/statements"
},
"Meta": {
"TotalPages": 1
}
}9. Account Statement – File Download
This API allows an AISP to retrieve a file of a single statement identified by the unique AccountID and StatementID. The API will return unstructured data in PDF format which can be downloaded. This will be specified in the Accept header by the AISP. BOI currently supports only PDF format. BOI will provide a sample PDF statement when the Sandbox APIs are invoked through a tool.
GET request: Accounts Statements File
GET /accounts/27f4beab-01df-4d05-8782-05d7e7e31237/statements/10012064/file HTTP/1.1
Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 234.213.211.123
x-fapi-interaction-id: ca41a048-bb6a-4a87-bffb-2b5802e4ede4
Content-Type: application/pdf
Accept: application/pdf
GET response: Accounts Statements File By StatementId
HTTP/1.1 200 OK
x-fapi-interaction-id: ca41a048-bb6a-4a87-bffb-2b5802e4ede4
Content-Type: application/pdf
10. Single Account Transaction
This API allows an AISP to retrieve transaction information of a single bank account identified by the unique AccountID.
BOI provides the Proprietary Bank Transaction Code that defines the type of transaction. Description for the code can be viewed here.
The following optional field(s) is/are not populated by BOI for this API:
• StatementReference
• TransactionReference
• TransactionMutability
• ChargeAmount
• CurrencyExchange
• BankTransactionCode
• ProprietaryBankTransactionCode.Issuer
• DebtorAgent
• DebtorAccount
• CreditorAgent
• CreditorAccount
• CardInstrument
• SupplementaryData
GET request: Accounts Transactions
GET /accounts/ /transactions HTTP/1.1
Authorization: Bearer 1UqG12JG2uiIBDYy8VTxiyQvfVJ9
x-fapi-auth-date: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address: 234.213.211.123
x-fapi-interaction-id: 6d412a5c-5167-47a2-a415-82a99c876750
Accept: application/json
GET response: Accounts Transactions
HTTP/1.1 200 OK
x-fapi-interaction-id: 6d412a5c-5167-47a2-a415-82a99c876750
Content-Type: application/json
{
"Data": {
"Transaction": [
{
"AccountId": "4dee4f2b-e316-4fde-83cd-90861568873a",
"TransactionId": "1234",
"TransactionReference": "Ref 123",
"StatementReference": [
"Test"
],
"CreditDebitIndicator": "Debit",
"Status": "INFO",
"TransactionMutability": "Mutable",
"BookingDateTime": "2026-01-10T10:00:00.000Z",
"ValueDateTime": "2044-12-03T00:00:00Z",
"TransactionInformation": "Transaction processed on account XXXXXXXX",
"AddressLine": "string",
"Amount": {
"Amount": "11.11",
"Currency": "GBP"
},
"ChargeAmount": {
"Amount": "11.11",
"Currency": "GBP"
},
"CurrencyExchange": {
"SourceCurrency": "GBP",
"TargetCurrency": "GBP",
"UnitCurrency": "GBP",
"ExchangeRate": 0.01,
"ContractIdentification": "test",
"QuotationDate": "2017-04-05T10:43:07+00:00",
"InstructedAmount": {
"Amount": "11.11",
"Currency": "GBP"
}
},
"BankTransactionCode": {
"Code": "code",
"SubCode": "string"
},
"ProprietaryBankTransactionCode": {
"Code": "Transfer",
"Issuer": "AlphaBank"
},
"Balance": {
"CreditDebitIndicator": "Debit",
"Type": "INFO",
"Amount": {
"Amount": "230.00",
"Currency": "GBP"
}
},
"MerchantDetails": {
"MerchantName": "string",
"MerchantCategoryCode": "code"
},
"CreditorAgent": {
"lei": "IZ9Q00LZEVUKWCQY6X15",
"SchemeName": "UK.OBIE.BICFI",
"Identification": "string",
"Name": "string",
"LEI": "IZ9Q00LZEVUKWCQY6X15",
"PostalAddress": {
"AddressType": "MLTO",
"Department": "string",
"SubDepartment": "string",
"StreetName": "string",
"BuildingNumber": "123456",
"BuildingName": "Madhura",
"Floor": "7",
"UnitNumber": "testUnitNumber",
"Room": "testRoom",
"PostBox": "testPostBox",
"TownLocationName": "testTownLocationName",
"DistrictName": "testDistrictName",
"CareOf": "testCareOf",
"PostCode": "1234",
"TownName": "string",
"CountrySubDivision": "string",
"Country": "GB",
"AddressLine": [
"TestAddress"
]
}
},
"CreditorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE64IRCE92050112345678",
"Name": "JESSICA",
"SecondaryIdentification": "5999999",
"Proxy": {
"Identification": "2360549017905188",
"Code": "DNAM",
"Type": "test"
}
},
"DebtorAgent": {
"lei": "IZ9Q00LZEVUKWCQY6X15",
"SchemeName": "UK.OBIE.BICFI",
"Identification": "string",
"Name": "string",
"LEI": "IZ9Q00LZEVUKWCQY6X15",
"PostalAddress": {
"AddressType": "MLTO",
"Department": "string",
"SubDepartment": "string",
"StreetName": "string",
"BuildingNumber": "123456",
"BuildingName": "Madhura",
"Floor": "7",
"UnitNumber": "testUnitNumber",
"Room": "testRoom",
"PostBox": "testPostBox",
"TownLocationName": "testTownLocationName",
"DistrictName": "testDistrictName",
"CareOf": "testCareOf",
"PostCode": "1234",
"TownName": "string",
"CountrySubDivision": "string",
"Country": "GB",
"AddressLine": [
"TestAddress"
]
}
},
"DebtorAccount": {
"SchemeName": "UK.OBIE.IBAN",
"Identification": "IE64IRCE92050112345678",
"Name": "JESSICA",
"SecondaryIdentification": "54988",
"Proxy": {
"Identification": "2360549017905188",
"Code": "DNAM",
"Type": "test"
}
},
"CardInstrument": {
"CardSchemeName": "Discover",
"AuthorisationType": "Contactless",
"Name": "string",
"Identification": "string"
}
}
]
},
"Links": {
"Self": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/aisp/accounts/4dee4f2b-e316-4fde-83cd-90861568873a/transactions",
"Last": "https://api.boi-sandbox.apiboitest.com/1/api/open-banking/v4.0/aisp/accounts/4dee4f2b-e316-4fde-83cd-90861568873a/transactions?page=1"
},
"Meta": {
"TotalPages": 1,
"FirstAvailableDateTime": "2018-09-03T00:00:00Z",
"LastAvailableDateTime": "2019-04-03T00:00:00Z"
}
}Versioning
This API specification conforms to the Open Banking UK Account and Transaction API Specification – v4.0
Reviews